home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Vk / VkMsgComponent.z / VkMsgComponent
Encoding:
Text File  |  2002-10-03  |  7.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkMMMMssssggggCCCCoooommmmppppoooonnnneeeennnntttt((((3333xxxx))))                                          VVVVkkkkMMMMssssggggCCCCoooommmmppppoooonnnneeeennnntttt((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkMsgComponent - Abstract base class for all ViewKit message components
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkComponent :  VkCallbackObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkMsgComponent.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkMsgComponent(const char* name);
  20.            virtual void ~VkMsgComponent(void);
  21.  
  22.  
  23.    MMMMeeeessssssssaaaaggggeeee FFFFaaaacccciiiilllliiiittttyyyy AAAAcccccccceeeessssssss
  24.            VkMsgClient* messageClient(void);
  25.  
  26.            void updatePatterns(void);
  27.  
  28.            VkMsgPattern addAction(char* name,
  29.                                   VkMsgClientAction proc,
  30.                                   void *client_data,
  31.                                   VkMsgActionType type,
  32.                                   Boolean deleteMessage = True);
  33.  
  34.            VkMsgPattern createAction(char* name,
  35.                                      VkMsgClientAction proc,
  36.                                      void *client_data,
  37.                                      VkMsgActionType type,
  38.                                      Boolean deleteMessage = True);
  39.  
  40.            void removeAction(VkMsgPattern pat);
  41.  
  42.            void addTranslation(char* name,
  43.                                VkMsgClientAction proc,
  44.                                void *client_data,
  45.                                Boolean deleteMessage = True);
  46.  
  47.            void removeTranslation(char* name);
  48.  
  49.            VkMsgStatus registerPattern(VkMsgPattern pat);
  50.  
  51.            VkMsgStatus unregisterPattern(VkMsgPattern pat);
  52.  
  53.            VkMsgStatus destroyPattern(VkMsgPattern pat);
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkMMMMssssggggCCCCoooommmmppppoooonnnneeeennnntttt((((3333xxxx))))                                          VVVVkkkkMMMMssssggggCCCCoooommmmppppoooonnnneeeennnntttt((((3333xxxx))))
  71.  
  72.  
  73.  
  74. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  75.           VkMsgComponent is a subclass of VkComponent which creates a
  76.           VkMsgClient object.  Components which handle messages (e.g. an
  77.           editor component that sends and receives its own messages) should be
  78.           subclasses of VkMsgComponent.  There are convenience methods for
  79.           accessing VkMsgClient methods.
  80.  
  81.  
  82.  
  83. DDDDEEEERRRRIIIIVVVVIIIINNNNGGGG SSSSUUUUBBBBCCCCLLLLAAAASSSSSSSSEEEESSSS
  84.           The same guidelines for deriving from VkComponent apply to
  85.           VkMsgComponent subclasses.
  86.  
  87.  
  88.  
  89. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  90.    VVVVkkkkMMMMssssggggCCCCoooommmmppppoooonnnneeeennnntttt(((())))
  91.            VkMsgComponent(const char* name);
  92.            virtual void ~VkMsgComponent(void);
  93.  
  94.  
  95.           Same as VkComponent constructor
  96.  
  97.    mmmmeeeessssssssaaaaggggeeeeCCCClllliiiieeeennnntttt(((())))
  98.            VkMsgClient* messageClient(void);
  99.  
  100.  
  101.           Returns a pointer to the VkMsgClient object for access to message
  102.           facility functionality.  See the VkMsgClient man page for more
  103.           details.
  104.  
  105.    MMMMeeeessssssssaaaaggggeeee RRRRoooouuuuttttiiiinnnneeeessss
  106.            void updatePatterns(void);
  107.  
  108.            VkMsgPattern addAction(char* name,
  109.                                   VkMsgClientAction proc,
  110.                                   void *client_data,
  111.                                   VkMsgActionType type,
  112.                                   Boolean deleteMessage = True);
  113.  
  114.            VkMsgPattern createAction(char* name,
  115.                                      VkMsgClientAction proc,
  116.                                      void *client_data,
  117.                                      VkMsgActionType type,
  118.                                      Boolean deleteMessage = True);
  119.  
  120.            void removeAction(VkMsgPattern pat);
  121.  
  122.            void addTranslation(char* name,
  123.                                VkMsgClientAction proc,
  124.                                void *client_data,
  125.                                Boolean deleteMessage = True);
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkMMMMssssggggCCCCoooommmmppppoooonnnneeeennnntttt((((3333xxxx))))                                          VVVVkkkkMMMMssssggggCCCCoooommmmppppoooonnnneeeennnntttt((((3333xxxx))))
  137.  
  138.  
  139.  
  140.            void removeTranslation(char* name);
  141.  
  142.            VkMsgStatus registerPattern(VkMsgPattern pat);
  143.  
  144.            VkMsgStatus unregisterPattern(VkMsgPattern pat);
  145.  
  146.            VkMsgStatus destroyPattern(VkMsgPattern pat);
  147.  
  148.  
  149.           Convenience routines for accessing VkMsgClient methods.  See the
  150.           VkMsgClient man page for more details.
  151.  
  152. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  153.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  154.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  155.           setDefaultResources(), getResources(), manage(), unmanage(),
  156.           baseWidget(), okToQuit(), _name, _baseWidget, _w, deleteCallback
  157.  
  158.  
  159.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  160.           callCallbacks(), addCallback(), removeCallback(),
  161.           removeAllCallbacks()
  162.  
  163.  
  164. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  165.      VkMsgClient, VkMsgService
  166.  
  167. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  168.      VkComponent, VkMsgClient, VkMsgComponent, VkMsgService
  169.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  170.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  171.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  172.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.